<HTML>
<BODY BGCOLOR="white">
<PRE>
<FONT color="green">001</FONT>    /*<a name="line.1"></a>
<FONT color="green">002</FONT>     * Licensed to the Apache Software Foundation (ASF) under one or more<a name="line.2"></a>
<FONT color="green">003</FONT>     * contributor license agreements.  See the NOTICE file distributed with<a name="line.3"></a>
<FONT color="green">004</FONT>     * this work for additional information regarding copyright ownership.<a name="line.4"></a>
<FONT color="green">005</FONT>     * The ASF licenses this file to You under the Apache License, Version 2.0<a name="line.5"></a>
<FONT color="green">006</FONT>     * (the "License"); you may not use this file except in compliance with<a name="line.6"></a>
<FONT color="green">007</FONT>     * the License.  You may obtain a copy of the License at<a name="line.7"></a>
<FONT color="green">008</FONT>     *<a name="line.8"></a>
<FONT color="green">009</FONT>     *      http://www.apache.org/licenses/LICENSE-2.0<a name="line.9"></a>
<FONT color="green">010</FONT>     *<a name="line.10"></a>
<FONT color="green">011</FONT>     * Unless required by applicable law or agreed to in writing, software<a name="line.11"></a>
<FONT color="green">012</FONT>     * distributed under the License is distributed on an "AS IS" BASIS,<a name="line.12"></a>
<FONT color="green">013</FONT>     * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.<a name="line.13"></a>
<FONT color="green">014</FONT>     * See the License for the specific language governing permissions and<a name="line.14"></a>
<FONT color="green">015</FONT>     * limitations under the License.<a name="line.15"></a>
<FONT color="green">016</FONT>     */<a name="line.16"></a>
<FONT color="green">017</FONT>    <a name="line.17"></a>
<FONT color="green">018</FONT>    package org.apache.commons.net.telnet;<a name="line.18"></a>
<FONT color="green">019</FONT>    <a name="line.19"></a>
<FONT color="green">020</FONT>    /***<a name="line.20"></a>
<FONT color="green">021</FONT>     * The TelnetOptionHandler class is the base class to be used<a name="line.21"></a>
<FONT color="green">022</FONT>     * for implementing handlers for telnet options.<a name="line.22"></a>
<FONT color="green">023</FONT>     * &lt;p&gt;<a name="line.23"></a>
<FONT color="green">024</FONT>     * TelnetOptionHandler implements basic option handling<a name="line.24"></a>
<FONT color="green">025</FONT>     * functionality and defines abstract methods that must be<a name="line.25"></a>
<FONT color="green">026</FONT>     * implemented to define subnegotiation behaviour.<a name="line.26"></a>
<FONT color="green">027</FONT>     * &lt;p&gt;<a name="line.27"></a>
<FONT color="green">028</FONT>     * @author Bruno D'Avanzo<a name="line.28"></a>
<FONT color="green">029</FONT>     ***/<a name="line.29"></a>
<FONT color="green">030</FONT>    public abstract class TelnetOptionHandler<a name="line.30"></a>
<FONT color="green">031</FONT>    {<a name="line.31"></a>
<FONT color="green">032</FONT>        /***<a name="line.32"></a>
<FONT color="green">033</FONT>         * Option code<a name="line.33"></a>
<FONT color="green">034</FONT>         ***/<a name="line.34"></a>
<FONT color="green">035</FONT>        private int optionCode = -1;<a name="line.35"></a>
<FONT color="green">036</FONT>    <a name="line.36"></a>
<FONT color="green">037</FONT>        /***<a name="line.37"></a>
<FONT color="green">038</FONT>         * true if the option should be activated on the local side<a name="line.38"></a>
<FONT color="green">039</FONT>         ***/<a name="line.39"></a>
<FONT color="green">040</FONT>        private boolean initialLocal = false;<a name="line.40"></a>
<FONT color="green">041</FONT>    <a name="line.41"></a>
<FONT color="green">042</FONT>        /***<a name="line.42"></a>
<FONT color="green">043</FONT>         * true if the option should be activated on the remote side<a name="line.43"></a>
<FONT color="green">044</FONT>         ***/<a name="line.44"></a>
<FONT color="green">045</FONT>        private boolean initialRemote = false;<a name="line.45"></a>
<FONT color="green">046</FONT>    <a name="line.46"></a>
<FONT color="green">047</FONT>        /***<a name="line.47"></a>
<FONT color="green">048</FONT>         * true if the option should be accepted on the local side<a name="line.48"></a>
<FONT color="green">049</FONT>         ***/<a name="line.49"></a>
<FONT color="green">050</FONT>        private boolean acceptLocal = false;<a name="line.50"></a>
<FONT color="green">051</FONT>    <a name="line.51"></a>
<FONT color="green">052</FONT>        /***<a name="line.52"></a>
<FONT color="green">053</FONT>         * true if the option should be accepted on the remote side<a name="line.53"></a>
<FONT color="green">054</FONT>         ***/<a name="line.54"></a>
<FONT color="green">055</FONT>        private boolean acceptRemote = false;<a name="line.55"></a>
<FONT color="green">056</FONT>    <a name="line.56"></a>
<FONT color="green">057</FONT>        /***<a name="line.57"></a>
<FONT color="green">058</FONT>         * true if the option is active on the local side<a name="line.58"></a>
<FONT color="green">059</FONT>         ***/<a name="line.59"></a>
<FONT color="green">060</FONT>        private boolean doFlag = false;<a name="line.60"></a>
<FONT color="green">061</FONT>    <a name="line.61"></a>
<FONT color="green">062</FONT>        /***<a name="line.62"></a>
<FONT color="green">063</FONT>         * true if the option is active on the remote side<a name="line.63"></a>
<FONT color="green">064</FONT>         ***/<a name="line.64"></a>
<FONT color="green">065</FONT>        private boolean willFlag = false;<a name="line.65"></a>
<FONT color="green">066</FONT>    <a name="line.66"></a>
<FONT color="green">067</FONT>        /***<a name="line.67"></a>
<FONT color="green">068</FONT>         * Constructor for the TelnetOptionHandler. Allows defining desired<a name="line.68"></a>
<FONT color="green">069</FONT>         * initial setting for local/remote activation of this option and<a name="line.69"></a>
<FONT color="green">070</FONT>         * behaviour in case a local/remote activation request for this<a name="line.70"></a>
<FONT color="green">071</FONT>         * option is received.<a name="line.71"></a>
<FONT color="green">072</FONT>         * &lt;p&gt;<a name="line.72"></a>
<FONT color="green">073</FONT>         * @param optcode - Option code.<a name="line.73"></a>
<FONT color="green">074</FONT>         * @param initlocal - if set to true, a WILL is sent upon connection.<a name="line.74"></a>
<FONT color="green">075</FONT>         * @param initremote - if set to true, a DO is sent upon connection.<a name="line.75"></a>
<FONT color="green">076</FONT>         * @param acceptlocal - if set to true, any DO request is accepted.<a name="line.76"></a>
<FONT color="green">077</FONT>         * @param acceptremote - if set to true, any WILL request is accepted.<a name="line.77"></a>
<FONT color="green">078</FONT>         ***/<a name="line.78"></a>
<FONT color="green">079</FONT>        public TelnetOptionHandler(int optcode,<a name="line.79"></a>
<FONT color="green">080</FONT>                                    boolean initlocal,<a name="line.80"></a>
<FONT color="green">081</FONT>                                    boolean initremote,<a name="line.81"></a>
<FONT color="green">082</FONT>                                    boolean acceptlocal,<a name="line.82"></a>
<FONT color="green">083</FONT>                                    boolean acceptremote)<a name="line.83"></a>
<FONT color="green">084</FONT>        {<a name="line.84"></a>
<FONT color="green">085</FONT>            optionCode = optcode;<a name="line.85"></a>
<FONT color="green">086</FONT>            initialLocal = initlocal;<a name="line.86"></a>
<FONT color="green">087</FONT>            initialRemote = initremote;<a name="line.87"></a>
<FONT color="green">088</FONT>            acceptLocal = acceptlocal;<a name="line.88"></a>
<FONT color="green">089</FONT>            acceptRemote = acceptremote;<a name="line.89"></a>
<FONT color="green">090</FONT>        }<a name="line.90"></a>
<FONT color="green">091</FONT>    <a name="line.91"></a>
<FONT color="green">092</FONT>    <a name="line.92"></a>
<FONT color="green">093</FONT>        /***<a name="line.93"></a>
<FONT color="green">094</FONT>         * Returns the option code for this option.<a name="line.94"></a>
<FONT color="green">095</FONT>         * &lt;p&gt;<a name="line.95"></a>
<FONT color="green">096</FONT>         * @return Option code.<a name="line.96"></a>
<FONT color="green">097</FONT>         ***/<a name="line.97"></a>
<FONT color="green">098</FONT>        public int getOptionCode()<a name="line.98"></a>
<FONT color="green">099</FONT>        {<a name="line.99"></a>
<FONT color="green">100</FONT>            return (optionCode);<a name="line.100"></a>
<FONT color="green">101</FONT>        }<a name="line.101"></a>
<FONT color="green">102</FONT>    <a name="line.102"></a>
<FONT color="green">103</FONT>        /***<a name="line.103"></a>
<FONT color="green">104</FONT>         * Returns a boolean indicating whether to accept a DO<a name="line.104"></a>
<FONT color="green">105</FONT>         * request coming from the other end.<a name="line.105"></a>
<FONT color="green">106</FONT>         * &lt;p&gt;<a name="line.106"></a>
<FONT color="green">107</FONT>         * @return true if a DO request shall be accepted.<a name="line.107"></a>
<FONT color="green">108</FONT>         ***/<a name="line.108"></a>
<FONT color="green">109</FONT>        public boolean getAcceptLocal()<a name="line.109"></a>
<FONT color="green">110</FONT>        {<a name="line.110"></a>
<FONT color="green">111</FONT>            return (acceptLocal);<a name="line.111"></a>
<FONT color="green">112</FONT>        }<a name="line.112"></a>
<FONT color="green">113</FONT>    <a name="line.113"></a>
<FONT color="green">114</FONT>        /***<a name="line.114"></a>
<FONT color="green">115</FONT>         * Returns a boolean indicating whether to accept a WILL<a name="line.115"></a>
<FONT color="green">116</FONT>         * request coming from the other end.<a name="line.116"></a>
<FONT color="green">117</FONT>         * &lt;p&gt;<a name="line.117"></a>
<FONT color="green">118</FONT>         * @return true if a WILL request shall be accepted.<a name="line.118"></a>
<FONT color="green">119</FONT>         ***/<a name="line.119"></a>
<FONT color="green">120</FONT>        public boolean getAcceptRemote()<a name="line.120"></a>
<FONT color="green">121</FONT>        {<a name="line.121"></a>
<FONT color="green">122</FONT>            return (acceptRemote);<a name="line.122"></a>
<FONT color="green">123</FONT>        }<a name="line.123"></a>
<FONT color="green">124</FONT>    <a name="line.124"></a>
<FONT color="green">125</FONT>        /***<a name="line.125"></a>
<FONT color="green">126</FONT>         * Set behaviour of the option for DO requests coming from<a name="line.126"></a>
<FONT color="green">127</FONT>         * the other end.<a name="line.127"></a>
<FONT color="green">128</FONT>         * &lt;p&gt;<a name="line.128"></a>
<FONT color="green">129</FONT>         * @param accept - if true, subsequent DO requests will be accepted.<a name="line.129"></a>
<FONT color="green">130</FONT>         ***/<a name="line.130"></a>
<FONT color="green">131</FONT>        public void setAcceptLocal(boolean accept)<a name="line.131"></a>
<FONT color="green">132</FONT>        {<a name="line.132"></a>
<FONT color="green">133</FONT>            acceptLocal = accept;<a name="line.133"></a>
<FONT color="green">134</FONT>        }<a name="line.134"></a>
<FONT color="green">135</FONT>    <a name="line.135"></a>
<FONT color="green">136</FONT>        /***<a name="line.136"></a>
<FONT color="green">137</FONT>         * Set behaviour of the option for WILL requests coming from<a name="line.137"></a>
<FONT color="green">138</FONT>         * the other end.<a name="line.138"></a>
<FONT color="green">139</FONT>         * &lt;p&gt;<a name="line.139"></a>
<FONT color="green">140</FONT>         * @param accept - if true, subsequent WILL requests will be accepted.<a name="line.140"></a>
<FONT color="green">141</FONT>         ***/<a name="line.141"></a>
<FONT color="green">142</FONT>        public void setAcceptRemote(boolean accept)<a name="line.142"></a>
<FONT color="green">143</FONT>        {<a name="line.143"></a>
<FONT color="green">144</FONT>            acceptRemote = accept;<a name="line.144"></a>
<FONT color="green">145</FONT>        }<a name="line.145"></a>
<FONT color="green">146</FONT>    <a name="line.146"></a>
<FONT color="green">147</FONT>        /***<a name="line.147"></a>
<FONT color="green">148</FONT>         * Returns a boolean indicating whether to send a WILL request<a name="line.148"></a>
<FONT color="green">149</FONT>         * to the other end upon connection.<a name="line.149"></a>
<FONT color="green">150</FONT>         * &lt;p&gt;<a name="line.150"></a>
<FONT color="green">151</FONT>         * @return true if a WILL request shall be sent upon connection.<a name="line.151"></a>
<FONT color="green">152</FONT>         ***/<a name="line.152"></a>
<FONT color="green">153</FONT>        public boolean getInitLocal()<a name="line.153"></a>
<FONT color="green">154</FONT>        {<a name="line.154"></a>
<FONT color="green">155</FONT>            return (initialLocal);<a name="line.155"></a>
<FONT color="green">156</FONT>        }<a name="line.156"></a>
<FONT color="green">157</FONT>    <a name="line.157"></a>
<FONT color="green">158</FONT>        /***<a name="line.158"></a>
<FONT color="green">159</FONT>         * Returns a boolean indicating whether to send a DO request<a name="line.159"></a>
<FONT color="green">160</FONT>         * to the other end upon connection.<a name="line.160"></a>
<FONT color="green">161</FONT>         * &lt;p&gt;<a name="line.161"></a>
<FONT color="green">162</FONT>         * @return true if a DO request shall be sent upon connection.<a name="line.162"></a>
<FONT color="green">163</FONT>         ***/<a name="line.163"></a>
<FONT color="green">164</FONT>        public boolean getInitRemote()<a name="line.164"></a>
<FONT color="green">165</FONT>        {<a name="line.165"></a>
<FONT color="green">166</FONT>            return (initialRemote);<a name="line.166"></a>
<FONT color="green">167</FONT>        }<a name="line.167"></a>
<FONT color="green">168</FONT>    <a name="line.168"></a>
<FONT color="green">169</FONT>        /***<a name="line.169"></a>
<FONT color="green">170</FONT>         * Tells this option whether to send a WILL request upon connection.<a name="line.170"></a>
<FONT color="green">171</FONT>         * &lt;p&gt;<a name="line.171"></a>
<FONT color="green">172</FONT>         * @param init - if true, a WILL request will be sent upon subsequent<a name="line.172"></a>
<FONT color="green">173</FONT>         * connections.<a name="line.173"></a>
<FONT color="green">174</FONT>         ***/<a name="line.174"></a>
<FONT color="green">175</FONT>        public void setInitLocal(boolean init)<a name="line.175"></a>
<FONT color="green">176</FONT>        {<a name="line.176"></a>
<FONT color="green">177</FONT>            initialLocal = init;<a name="line.177"></a>
<FONT color="green">178</FONT>        }<a name="line.178"></a>
<FONT color="green">179</FONT>    <a name="line.179"></a>
<FONT color="green">180</FONT>        /***<a name="line.180"></a>
<FONT color="green">181</FONT>         * Tells this option whether to send a DO request upon connection.<a name="line.181"></a>
<FONT color="green">182</FONT>         * &lt;p&gt;<a name="line.182"></a>
<FONT color="green">183</FONT>         * @param init - if true, a DO request will be sent upon subsequent<a name="line.183"></a>
<FONT color="green">184</FONT>         * connections.<a name="line.184"></a>
<FONT color="green">185</FONT>         ***/<a name="line.185"></a>
<FONT color="green">186</FONT>        public void setInitRemote(boolean init)<a name="line.186"></a>
<FONT color="green">187</FONT>        {<a name="line.187"></a>
<FONT color="green">188</FONT>            initialRemote = init;<a name="line.188"></a>
<FONT color="green">189</FONT>        }<a name="line.189"></a>
<FONT color="green">190</FONT>    <a name="line.190"></a>
<FONT color="green">191</FONT>        /***<a name="line.191"></a>
<FONT color="green">192</FONT>         * Method called upon reception of a subnegotiation for this option<a name="line.192"></a>
<FONT color="green">193</FONT>         * coming from the other end.<a name="line.193"></a>
<FONT color="green">194</FONT>         * Must be implemented by the actual TelnetOptionHandler to specify<a name="line.194"></a>
<FONT color="green">195</FONT>         * which response must be sent for the subnegotiation request.<a name="line.195"></a>
<FONT color="green">196</FONT>         * &lt;p&gt;<a name="line.196"></a>
<FONT color="green">197</FONT>         * @param suboptionData - the sequence received, whithout IAC SB &amp; IAC SE<a name="line.197"></a>
<FONT color="green">198</FONT>         * @param suboptionLength - the length of data in suboption_data<a name="line.198"></a>
<FONT color="green">199</FONT>         * &lt;p&gt;<a name="line.199"></a>
<FONT color="green">200</FONT>         * @return response to be sent to the subnegotiation sequence. TelnetClient<a name="line.200"></a>
<FONT color="green">201</FONT>         * will add IAC SB &amp; IAC SE. null means no response<a name="line.201"></a>
<FONT color="green">202</FONT>         ***/<a name="line.202"></a>
<FONT color="green">203</FONT>        public abstract int[] answerSubnegotiation(int suboptionData[],<a name="line.203"></a>
<FONT color="green">204</FONT>                                int suboptionLength);<a name="line.204"></a>
<FONT color="green">205</FONT>    <a name="line.205"></a>
<FONT color="green">206</FONT>        /***<a name="line.206"></a>
<FONT color="green">207</FONT>         * This method is invoked whenever this option is acknowledged active on<a name="line.207"></a>
<FONT color="green">208</FONT>         * the local end (TelnetClient sent a WILL, remote side sent a DO).<a name="line.208"></a>
<FONT color="green">209</FONT>         * The method is used to specify a subnegotiation sequence that will be<a name="line.209"></a>
<FONT color="green">210</FONT>         * sent by TelnetClient when the option is activated.<a name="line.210"></a>
<FONT color="green">211</FONT>         * &lt;p&gt;<a name="line.211"></a>
<FONT color="green">212</FONT>         * @return subnegotiation sequence to be sent by TelnetClient. TelnetClient<a name="line.212"></a>
<FONT color="green">213</FONT>         * will add IAC SB &amp; IAC SE. null means no subnegotiation.<a name="line.213"></a>
<FONT color="green">214</FONT>         ***/<a name="line.214"></a>
<FONT color="green">215</FONT>        public abstract int[] startSubnegotiationLocal();<a name="line.215"></a>
<FONT color="green">216</FONT>    <a name="line.216"></a>
<FONT color="green">217</FONT>        /***<a name="line.217"></a>
<FONT color="green">218</FONT>         * This method is invoked whenever this option is acknowledged active on<a name="line.218"></a>
<FONT color="green">219</FONT>         * the remote end (TelnetClient sent a DO, remote side sent a WILL).<a name="line.219"></a>
<FONT color="green">220</FONT>         * The method is used to specify a subnegotiation sequence that will be<a name="line.220"></a>
<FONT color="green">221</FONT>         * sent by TelnetClient when the option is activated.<a name="line.221"></a>
<FONT color="green">222</FONT>         * &lt;p&gt;<a name="line.222"></a>
<FONT color="green">223</FONT>         * @return subnegotiation sequence to be sent by TelnetClient. TelnetClient<a name="line.223"></a>
<FONT color="green">224</FONT>         * will add IAC SB &amp; IAC SE. null means no subnegotiation.<a name="line.224"></a>
<FONT color="green">225</FONT>         ***/<a name="line.225"></a>
<FONT color="green">226</FONT>        public abstract int[] startSubnegotiationRemote();<a name="line.226"></a>
<FONT color="green">227</FONT>    <a name="line.227"></a>
<FONT color="green">228</FONT>        /***<a name="line.228"></a>
<FONT color="green">229</FONT>         * Returns a boolean indicating whether a WILL request sent to the other<a name="line.229"></a>
<FONT color="green">230</FONT>         * side has been acknowledged.<a name="line.230"></a>
<FONT color="green">231</FONT>         * &lt;p&gt;<a name="line.231"></a>
<FONT color="green">232</FONT>         * @return true if a WILL sent to the other side has been acknowledged.<a name="line.232"></a>
<FONT color="green">233</FONT>         ***/<a name="line.233"></a>
<FONT color="green">234</FONT>        boolean getWill()<a name="line.234"></a>
<FONT color="green">235</FONT>        {<a name="line.235"></a>
<FONT color="green">236</FONT>            return willFlag;<a name="line.236"></a>
<FONT color="green">237</FONT>        }<a name="line.237"></a>
<FONT color="green">238</FONT>    <a name="line.238"></a>
<FONT color="green">239</FONT>        /***<a name="line.239"></a>
<FONT color="green">240</FONT>         * Tells this option whether a WILL request sent to the other<a name="line.240"></a>
<FONT color="green">241</FONT>         * side has been acknowledged (invoked by TelnetClient).<a name="line.241"></a>
<FONT color="green">242</FONT>         * &lt;p&gt;<a name="line.242"></a>
<FONT color="green">243</FONT>         * @param state - if true, a WILL request has been acknowledged.<a name="line.243"></a>
<FONT color="green">244</FONT>         ***/<a name="line.244"></a>
<FONT color="green">245</FONT>        void setWill(boolean state)<a name="line.245"></a>
<FONT color="green">246</FONT>        {<a name="line.246"></a>
<FONT color="green">247</FONT>            willFlag = state;<a name="line.247"></a>
<FONT color="green">248</FONT>        }<a name="line.248"></a>
<FONT color="green">249</FONT>    <a name="line.249"></a>
<FONT color="green">250</FONT>        /***<a name="line.250"></a>
<FONT color="green">251</FONT>         * Returns a boolean indicating whether a DO request sent to the other<a name="line.251"></a>
<FONT color="green">252</FONT>         * side has been acknowledged.<a name="line.252"></a>
<FONT color="green">253</FONT>         * &lt;p&gt;<a name="line.253"></a>
<FONT color="green">254</FONT>         * @return true if a DO sent to the other side has been acknowledged.<a name="line.254"></a>
<FONT color="green">255</FONT>         ***/<a name="line.255"></a>
<FONT color="green">256</FONT>        boolean getDo()<a name="line.256"></a>
<FONT color="green">257</FONT>        {<a name="line.257"></a>
<FONT color="green">258</FONT>            return doFlag;<a name="line.258"></a>
<FONT color="green">259</FONT>        }<a name="line.259"></a>
<FONT color="green">260</FONT>    <a name="line.260"></a>
<FONT color="green">261</FONT>    <a name="line.261"></a>
<FONT color="green">262</FONT>        /***<a name="line.262"></a>
<FONT color="green">263</FONT>         * Tells this option whether a DO request sent to the other<a name="line.263"></a>
<FONT color="green">264</FONT>         * side has been acknowledged (invoked by TelnetClient).<a name="line.264"></a>
<FONT color="green">265</FONT>         * &lt;p&gt;<a name="line.265"></a>
<FONT color="green">266</FONT>         * @param state - if true, a DO request has been acknowledged.<a name="line.266"></a>
<FONT color="green">267</FONT>         ***/<a name="line.267"></a>
<FONT color="green">268</FONT>        void setDo(boolean state)<a name="line.268"></a>
<FONT color="green">269</FONT>        {<a name="line.269"></a>
<FONT color="green">270</FONT>            doFlag = state;<a name="line.270"></a>
<FONT color="green">271</FONT>        }<a name="line.271"></a>
<FONT color="green">272</FONT>    }<a name="line.272"></a>




























































</PRE>
</BODY>
</HTML>
